Repository navigation
feat(base_msgs): add I8 base controller interfaces - #38
Evans-Kwashie wants to merge 24 commits into
Conversation
Signed-off-by: Evans Klenam Kwashie-Seyram <ekks2006@gmail.com>
panthera-momagdii
left a comment
There was a problem hiding this comment.
REQUEST_CHANGES at exact head ca44a258f056591484a75b2dca26f1868874053b.
The implementation is a useful proposed package and the exact-head hosted evidence is green: ROS 2 Jazzy run 42941431287 and Repository quality run 42941431718. I inspected both logs: the workspace built 3 packages, 18 generated interfaces were available, 14 compatibility tests ran, the retained-message consumer checks passed, and the reverted-interface negative check returned the expected exit 42. This is hosted ROS 2 software evidence only, not firmware, hardware, safety-chain or physical acceptance.
Two concrete P2 items need correction:
- Align
BaseAuxStatus.header.stampwith the frozen timestamp contract.CONTRACT.mdsays header.stamp is ROS time when available and diagnostic only;monotonic_usis the controller-local monotonic clock. The BaseAuxStatus comment currently says its header stamp is the base-controller monotonic time base, which conflicts with that contract and with BaseStatus. - Complete the producer/consumer owner mapping required by issue #30.
CONTRACT.mdsays owners are in the PR description, but the current description lists consumer components/repos without named owners or roles. Add the named producer and consumer owners (or link an explicit owner assignment) and make the statement accurate.
The Section 8 I8 decisions remain proposed, not accepted: notably the final message set, E-01-derived state semantics, fault registry IDs/lifecycle, measured/declared lift-position sources, and the robot lift-interlock owner/handshake. Keep the PR Draft and the contract Proposed until those owners resolve the decisions. This review does not approve a firmware implementation, lift interlock, safety function, or physical acceptance.
| |---|---|---|---| | ||
| | `/base/status` | `BaseStatus` | base-controller firmware (Teensy Gate A, STM32H723ZG Gate B), [openamr-platform-fw#10](https://github.com/openAMRobot/openamr-platform-fw/issues/10) | `navigation_status_node.py` in openamr-platform-sw, operator UI (openamrobot-ui #54), manipulation (openamrobot-manipulation #7), diagnostics, logging, tests | | ||
| | `/base/aux_status` | `BaseAuxStatus` | base-controller firmware, relayed from the lift node CTL-017 over CAN3 ([openamr-platform-fw#12](https://github.com/openAMRobot/openamr-platform-fw/issues/12), D17) | same as above | | ||
|
|
There was a problem hiding this comment.
Issue #30's Done-when requires producers and consumers to be listed with owners. The current PR description lists consumer components/repositories but does not name the producer or consumer owners/roles, so this sentence is not currently true. Please add an explicit owner/role mapping for the firmware producer and each downstream consumer (platform-sw, UI, manipulation, diagnostics/logging as applicable), or link the agreed assignments, then keep this statement accurate.
There was a problem hiding this comment.
Updated ros2/openamr_base_msgs/CONTRACT.md with the named ownership confirmations recorded in this PR: I8 producer (Evans-Kwashie), platform software consumer (skunal3318; Mohamed reviewing), UI consumer (panthera-momagdii), and manipulation consumer/authoritative arm-status producer (Brinex45 alongside panthera-momagdii). The PR description now links to that mapping. Diagnostics/logging ownership is still explicitly TBD, so I am leaving this thread open until that remaining owner is assigned.
|
Owner-decision follow-up at head ca44a25. The new #20/#30 direction proposes an explicit base-produced Please add an explicit permit field or a dedicated message only after the owner confirms the wire contract. It needs a defined producer, validity/freshness, sequence and boot-ID behaviour, and fail-closed withdrawal semantics for the CTL-017 consumer. Keep this Draft; the ROS 2 message build does not verify the firmware or bench path. |
Signed-off-by: Evans Klenam Kwashie-Seyram <ekks2006@gmail.com>
f2adf80 to
81deda4
Compare
…er-msgs # Conflicts: # STATE.md
|
Hi @skunal3318, @Brinex45, @panthera-momagdii, I'm following up on ownership for the I8 base-controller interfaces in PR #38. The package implementation is in place and CI is passing. Before we can finalise the contract, I need to confirm the accountable owners for the producer and downstream consumers. Based on the repository ownership files, could you please confirm the following assignments?
Please correct any assignment that is inaccurate and identify the accountable person where ownership is still unassigned. There is also an outstanding cross-repository decision concerning the lift-permit interface:
Could the relevant owners confirm the arm-status ownership and the remaining interface responsibilities, including freshness and withdrawal behaviour? I'll update Thanks. |
|
Thanks for clarifying the ownership assignments. I confirm my involvement as the manipulation-side consumer owner for From the manipulation side, I will take responsibility for the integration of the I8 interfaces and the authoritative arm-status information required by the lift interlock. For the lift interlock, I agree that:
I'd suggest keeping the exact I can coordinate the manipulation-side interface and consumer implementation once these details are agreed. |
|
Confirming: I'm the accountable owner for the platform software consumer side ( On the lift-interlock framing, I'm aligned with what Brinex45 laid out:
Agreed on locking the exact One thing still open from Mohamed's 11 Nov review that I want flagged again before this moves out of Draft: Once the schema/freshness/STOWED decisions and the |
|
Thanks, @Brinex45 and @skunal3318 — your replies clarify the cross-repository ownership and the intended lift-interlock direction. I’m recording the current working position from the I8 firmware/electrical side as follows:
There are still a few decisions to close before I update the contract:
I’ll keep PR #38 Draft and the contract Proposed while these decisions are open. Once the message scope and cross-repository interface details are confirmed, I’ll update Thanks. |
|
Following up on the first-release scope before I change the package contents. The 13 November I8 review proposes three messages only: Mohamed and Anushka: please record your positions on whether the two additional message types are required in Build 1 or should be deferred. There are nested-type dependencies that must be decided at the same time:
If the decision is to ship only three message types, we need an explicit decision to remove or replace those fields (and update their consumers/tests), rather than simply deleting the two message files. If the nested fields are required, the corresponding message types must remain in the package. I will not delete either message or claim the three-message scope is approved until the decision owners' positions are recorded. |
|
Implementation update on PR #38:
Still open: Mohamed and Anushka's positions on three versus five messages (including the The fields and semantics remain Proposed. PR #38 remains Draft. Hosted verification is running on the latest head. |
@BotshareAI for review
Summary
Adds the proposed I8 base-controller ROS 2 interface package,
openamr_base_msgs, toros2/openamr_base_msgs/.The package defines five messages:
BaseStatusBaseAuxStatusBaseFaultBaseSubsystemStatusBaseMotionConstraintAlso adds the package contract and README, 24 static interface regression tests, a Jazzy compatibility snapshot update, and the required
STATE.mdupdate.The implementation follows the I8 rev4 proposal. It does not claim that the proposal or its unresolved contract decisions have been approved.
Work package
Issue #30 — I8 base-controller interfaces.
Integration Gate
Reuses the repository's existing ROS 2 Jazzy workspace, package discovery/build structure, compatibility snapshot tooling, central verification test runner, and downstream interface-install consumer.
Existing
openamr_nav_msgsandopenamr_ui_msgspackages remain unchanged.The I8 package is added as a separate ROS 2 package under
ros2/. No existing navigation or UI interfaces were replaced.The compatibility snapshot was regenerated with the new package. Comparison confirmed that the existing navigation and UI package entries remained unchanged.
No firmware implementation, hardware interface, or safety-control implementation is introduced by this PR.
Tests
Added
tests/test_base_msgs.pywith 24 static contract checks covering message definitions, constants, fault identifiers, state semantics, lift validity/permit semantics, reset causes, ownership mapping, and prohibited interface additions.The tests are integrated into the repository's central verification harness.
Reversion check: the repository verification gate includes a negative compatibility fixture that removes
NavigationStatus.thresholds_idand confirms that the unchanged consumer rejects the incompatible interface with exit code 42.Evidence
Base SHA:
14912e18ecb6473ebd7ef4a42c4bd1870b2023f6Previously verified baseline head:
ca44a258f056591484a75b2dca26f1868874053b\n\nCurrent head after review fixes, proposed lift-permit updates and Jazzy snapshot regeneration:e1fdfd28cb3a2869f9cdfff0cae3a2f0b0bed73c. Fresh verification of this updated head is pending.Dependencies
The package uses ROS 2 Jazzy interface-generation and runtime dependencies declared in
ros2/openamr_base_msgs/package.xml.No new application-level runtime dependency is introduced.
For the full repository verification run, the local environment required the ROS Jazzy Cyclone DDS middleware package (
ros-jazzy-rmw-cyclonedds-cpp) in addition to the existing Fast DDS middleware. This was an environment prerequisite for the DDS verification stage, not a dependency added to the I8 message package.Decisions impact
This PR does not modify the organization decision register. The I8-specific message-schema and controller semantics remain proposed under I8 rev4. The package does not claim approval of the unresolved I8 decisions or implement the complete robot-level Resume, safety-chain or lift-interlock enforcement.
Decision-register classification requires confirmation against
openAMRobot/.github decisions.yamlbefore submission. This PR does not modify that register or claim approval of the open I8 decisions.Current ownership and interface status
The named producer/consumer ownership mapping is recorded in
ros2/openamr_base_msgs/CONTRACT.md.I8 firmware/electrical producer: Evans-Kwashie; platform software consumer: skunal3318
(with Mohamed reviewing); UI consumer: panthera-momagdii; manipulation consumer and
authoritative ArmStatus producer: Brinex45 alongside panthera-momagdii. Diagnostics/logging
ownership remains unassigned.
The 13 November I8 review proposed a three-message first release
(
BaseStatus,BaseAuxStatus,BaseFault). This branch currently contains five messagedefinitions. Mohamed and Anushka's positions are still required before deciding whether
BaseSubsystemStatusandBaseMotionConstraintremain. Note thatBaseAuxStatuscurrentlyuses
BaseSubsystemStatusas the type of itsreserved_inputsfield; deferring that messagetherefore also requires an explicit decision about that field.
The proposed
lift_permitfields, denial-reason candidates and fail-closed contract have been added toBaseAuxStatus/CONTRACT.md. Still open: ArmStatus schema, freshness and STOWED joint-spacesign-off; numerical permit maximum age and refresh/consumer timeout; reason-code mapping;
sequence-wrap semantics; base-stopped evidence source; and CTL-017 CAN PDO/object-dictionary
mapping. These are not represented as approved or physically validated.
Safety impact
Telemetry and proposed interface contract only.
No E-stop, brake, contactor, watchdog, motor-enable, charge-inhibit, safety I/O, or actuator-control implementation is changed.
The proposed status, readiness and lift-permit fields are not safety evidence and do not establish a safety function. Ownership direction is recorded: I8 produces the permit and CTL-017 is the final local enforcement point. The exact CAN PDO/object-dictionary mapping and physical/bench validation remain open.
STATE.md
Updated in this PR.
Records the I8 implementation, local verification result, proposed contract status, and remaining validation limitations.
Not verified
The verification evidence is local ROS 2 Jazzy software evidence only.
AI disclosure
AI assistance was used for planning, code review, test integration guidance, documentation review, and verification interpretation. The author reviewed the changes, executed the commands, and is responsible for the submitted implementation.
Contribution terms